Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve: rename Spoke Pool's hubPool variable to withdrawalRecipient #629

Merged
merged 2 commits into from
Oct 8, 2024

Conversation

bmzig
Copy link
Contributor

@bmzig bmzig commented Oct 3, 2024

This is meant to generalize the hubPool variable in all spoke pools. The hubPool variable is only used in _bridgeTokensToHubPool, where it is set as the recipient. For spoke pools deployed on L3s, or for spoke pools which may not want to withdraw token to the hub pool (e.g. the Blast_SpokePool), the hubPool variable is either a misnomer or unused. This changes the variable to be called withdrawalRecipient to better reflect the purpose of the hubPool variable.

Signed-off-by: bennett <bennett@umaproject.org>
Copy link
Contributor

@mrice32 mrice32 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Member

@nicholaspai nicholaspai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me as I have checked that there are no calls to SpokePool.hubPool() in production scripts. There are several non-production scripts using this though

@bmzig bmzig marked this pull request as ready for review October 8, 2024 15:23
Signed-off-by: bennett <bennett@umaproject.org>
@bmzig bmzig merged commit e38a2b7 into master Oct 8, 2024
9 checks passed
@bmzig bmzig deleted the bz/renameWithdrawalRecipient branch October 8, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants